home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / SgDynaMenu.z / SgDynaMenu
Encoding:
Text File  |  1998-10-20  |  15.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu - The DynaMenu widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<SSSSggggmmmm////DDDDyyyynnnnaaaaMMMMeeeennnnuuuu....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents the version of Sgm that accompanies
  17.           Motif 1.2.
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           The DynaMenu widget is packaged popup menu widget.  The
  21.           DynaMenu supports dynamic changing of menu entries. Pressing
  22.           mouse button 1 on the DynaMenu pops up its menu.  The
  23.           DynaMenu looks like a PushButton, but cannot be pushed-in.
  24.           Like a PushButton, it can accept either a label string or a
  25.           pixmap.  Currently, however, you must have access to the
  26.           private instance record to set the string or pixmap.
  27.  
  28.         CCCCllllaaaasssssssseeeessss
  29.           DynaMenu inherits behavior and resources from CCCCoooorrrreeee,
  30.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr.
  31.  
  32.           The class pointer is ssssggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuuWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  33.  
  34.           The class name is SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu.
  35.  
  36.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  37.           The following table defines a set of widget resources used
  38.           by the programmer to specify data.  The programmer can also
  39.           set the resource values for the inherited classes to set
  40.           attributes for this widget.  To reference a resource by name
  41.           or by class in a .Xdefaults file, remove the SSSSggggNNNN or SSSSggggCCCC
  42.           prefix and use the remaining letters.  To specify one of the
  43.           defined values for a resource in a .Xdefaults file, remove
  44.           the SSSSgggg prefix and use the remaining letters (in either
  45.           lowercase or uppercase, but include any underscores between
  46.           words).  The codes in the access column indicate if the
  47.           given resource can be set at creation time (C), set by using
  48.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  49.           not applicable (N/A).
  50.  
  51.                               SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  52.      NNNNaaaammmmeeee                      CCCCllllaaaassssssss          TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  53.      __________________________________________________________________________
  54.      SgNdynaPushCallback       XmCCallback    XtCallbackList   NULL      C
  55.      SgNhistoryListItems       XmCItems       XmStringTable    NULL      CSG
  56.      SgNhistoryListItemCount   XmCItemCount   int              0         CSG
  57.      SgNmaxHistoryCount        XmCItemCount   int              6         CG
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyLLLLiiiissssttttIIIItttteeeemmmmssss
  75.                     The items in the history menu.  These can be
  76.                     initialized to some set of strings which are
  77.                     useful to the user.  If left empty, the pulldown
  78.                     menu will be very small and have nothing in it.
  79.                     The number of items in the list should always
  80.                     match up with the number in
  81.                     SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyLLLLiiiissssttttIIIItttteeeemmmmCCCCoooouuuunnnntttt.  The widget makes a copy
  82.                     of the list items, so the programmer is
  83.                     responsible for XmStringFree'ing the list provided
  84.                     to widget in a SetValues.
  85.  
  86.           SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyLLLLiiiissssttttIIIItttteeeemmmmCCCCoooouuuunnnntttt
  87.                     The number of items in the history list.  This
  88.                     number should be at most SSSSggggNNNNmmmmaaaaxxxxHHHHiiiissssttttoooorrrryyyyCCCCoooouuuunnnntttt.  An
  89.                     error may result if this number is set to
  90.                     something different than the number of items in
  91.                     the SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyLLLLiiiissssttttIIIItttteeeemmmmssss or if it is greater than
  92.                     SSSSggggNNNNmmmmaaaaxxxxHHHHiiiissssttttoooorrrryyyyCCCCoooouuuunnnntttt.
  93.  
  94.           SSSSggggNNNNmmmmaaaaxxxxHHHHiiiissssttttoooorrrryyyyCCCCoooouuuunnnntttt
  95.                     The maximum number of items in the history list.
  96.                     This resource cannot be changed after widget
  97.                     creation.  It defaults to 6.  If more than
  98.                     SSSSggggNNNNmmmmaaaaxxxxHHHHiiiissssttttoooorrrryyyyCCCCoooouuuunnnntttt items are given to the list,
  99.                     only the first SSSSggggNNNNmmmmaaaaxxxxHHHHiiiissssttttoooorrrryyyyCCCCoooouuuunnnntttt are kept.  If an
  100.                     item is added to a full list, the last item on the
  101.                     list (the least recently used item) is dropped
  102.                     out.
  103.  
  104.  
  105.  
  106.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  107.           DynaMenu inherits behavior and resources from CCCCoooorrrreeee,
  108.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr.
  109.  
  110.                                           XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  111.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  112.      _________________________________________________________________________________________________
  113.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel               dynamic                CSG
  114.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  115.      XmNforeground           XmCForeground           Pixel               dynamic                CSG
  116.      XmNhelpCallback         XmCCallback             XtCallbackList      NULL                   C
  117.      XmNhighlightColor       XmCHighlightColor       Pixel               dynamic                CSG
  118.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap              dynamic                CSG
  119.      XmNinitialFocus         XmCInitialFocus         Widget              dynamic                CSG
  120.      XmNnavigationType       XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  121.      XmNshadowThickness      XmCShadowThickness      Dimension           dynamic                CSG
  122.      XmNstringDirection      XmCStringDirection      XmStringDirection   dynamic                CG
  123.      XmNtopShadowColor       XmCTopShadowColor       Pixel               dynamic                CSG
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap              dynamic                CSG
  141.      XmNtraversalOn          XmCTraversalOn          Boolean             True                   CSG
  142.      XmNunitType             XmCUnitType             unsigned char       dynamic                CSG
  143.      XmNuserData             XmCUserData             XtPointer           NULL                   CSG
  144.  
  145.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  146.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  147.      ______________________________________________________________________
  148.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  149.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  150.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  151.  
  152.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  153.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  154.      ______________________________________________________________________________________________________________
  155.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                N/A
  156.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  157.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  158.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  159.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  160.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  161.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  162.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  163.      XmNdepth                        XmCDepth                        int              dynamic                CG
  164.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  165.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  166.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  167.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  168.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  169.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  170.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  171.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  172.      XmNx                            XmCPosition                     Position         0                      CSG
  173.      XmNy                            XmCPosition                     Position         0                      CSG
  174.  
  175.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  176.           The Callback structure is SgDynaMenuCallbackStruct. A
  177.           pointer to the following structure is passed to each
  178.           callback:
  179.  
  180.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  181.           {{{{
  182.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  183.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  184.             iiiinnnntttt      _b_u_t_t_o_n__n_u_m_b_e_r;;;;
  185.           }}}} SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuuCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  186.  
  187.  
  188.           _r_e_a_s_o_n    Indicates why the callback was invoked. For a push
  189.                     on menu button, the reason will be SgCR_DYNA_PUSH.
  190.  
  191.           _e_v_e_n_t     Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           _b_u_t_t_o_n__n_u_m_b_e_r
  207.                     Specifies the button which was pressed. Range is
  208.                     from 0 to SSSSggggNNNNhhhhiiiissssttttoooorrrryyyyLLLLiiiissssttttIIIItttteeeemmmmssssCCCCoooouuuunnnntttt - 1.
  209.  
  210.  
  211.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  212.           CCCCoooorrrreeee((((3333XXXX)))), SSSSggggCCCCrrrreeeeaaaatttteeeeDDDDyyyynnnnaaaaMMMMeeeennnnuuuu((((3333XXXX)))),
  213.           SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuuAAAAddddddddHHHHiiiissssttttoooorrrryyyyIIIItttteeeemmmm((((3333XXXX)))), SSSSggggDDDDyyyynnnnaaaaMMMMeeeennnnuuuuCCCClllleeeeaaaarrrrHHHHiiiissssttttoooorrrryyyy((((3333XXXX)))),
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.